package org.jeecg.common.system.base.service;

import com.baomidou.mybatisplus.core.toolkit.support.SFunction;
import com.baomidou.mybatisplus.extension.service.IService;
import org.jeecg.common.system.base.entity.FieldRedisItem;
import org.springframework.validation.annotation.Validated;

import javax.validation.Valid;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;
import java.io.Serializable;
import java.util.Collection;
import java.util.Collections;
import java.util.List;

/**
 * 通用 Service
 *
 * @author chechen
 * @date 2022-04-16
 */
@Validated
public interface GenericService<E> extends IService<E> {

    String getName();

    /**
     * 获取所有所有带缓存的字段列表（必须设置主键缓存）
     */
    default List<FieldRedisItem<E>> getAllFieldCacheList() {
        return Collections.emptyList();
    }

    /**
     * 根据id获取实体（缓存）
     *
     * @param id id
     * @return 实体信息
     */
    E getByIdCache(@NotNull Serializable id);

    /**
     * 根据ids获取实体集合
     *
     * @param ids 商品分类id集合
     * @return 商品分类集合
     * @see #getByIdCache
     */
    List<E> selectListByIdsCache(Serializable... ids);

    /**
     * 根据实体字段获取实体列表（缓存）
     *
     * @param fieldValue 字段值
     * @param keyPrefix  redisKey 前缀
     * @return 实体列表
     * @deprecated 请转用 {@link #selectListByFieldCache(SFunction, Serializable)}
     */
    @Deprecated
    List<E> selectListByFieldCache(@NotNull Serializable fieldValue, @NotNull String keyPrefix);

    /**
     * 根据实体字段获取实体列表（缓存）
     *
     * @param fieldFunction 字段 function
     * @param fieldValue    字段值
     * @return 实体列表
     */
    List<E> selectListByFieldCache(@NotNull SFunction<E, Serializable> fieldFunction, @NotNull Serializable fieldValue);

    /**
     * 查询所有数据
     *
     * @return 实体列表
     */
    List<E> selectListAllCache();

    /**
     * 插入实体（缓存）
     * 非主键缓存删除策略
     *
     * @param entity 待插入的实体
     * @return 受影响行数
     */
    int insertCache(@NotNull @Valid E entity);

    /**
     * 批量插入实体（缓存）
     * 非主键缓存删除策略
     *
     * @param entityList 待插入的实体集合
     * @return 受影响行数
     */
    int insertBatchCache(@NotNull @Size(min = 1) @Valid List<E> entityList);

    /**
     * 更新实体（缓存）
     * 全缓存删除策略
     *
     * @param entity 待更新的实体
     * @return 受影响行数
     */
    int updateCache(@NotNull @Valid E entity);

    /**
     * 批量更新实体（缓存）
     * 全缓存删除策略
     *
     * @param entityList 待更新的实体集合
     * @return 受影响行数
     */
    int updateBatchCache(@NotNull @Size(min = 1) @Valid List<E> entityList);

    /**
     * 根据ids删除实体（缓存）
     * 主键缓存删除策略
     *
     * @param ids 实体ids
     * @return 受影响行数
     */
    int deleteByIdsCache(@NotNull @Size(min = 1) String... ids);

    /**
     * 根据ids删除实体（缓存）
     * 全缓存删除策略
     *
     * @param ids 实体ids
     * @return 受影响行数
     */
    int deleteByIdsAllCache(@NotNull @Size(min = 1) Serializable... ids);

    /**
     * 根据实体集合删除实体（缓存）
     * 全缓存删除策略
     *
     * @param entityList 从这里获取RedisKey的实体集合
     * @return 受影响行数
     */
    int deleteByEntityListAllCache(@NotNull @Size(min = 1) Collection<E> entityList);


}
